LScript User Guide
Next Section Previous Section Table of Contents Index Errata

Getting Started

Executing An LScript

Each time you start the LScript Scripting Plugin, a file-selection dialog box will appear. The first time you start the LScript Scripting Plugin, it will attempt to place you into the plugin directory specified by your Modeler configuration file (LWM.CFG) each time it displays this dialog box. Subsequent invocations of the plugin will place you back into the directory from where you selected your last script.

The file-selection dialog allows you to navigate to the directory that houses the LScript that you wish to execute. Once you select a script, LScript will compile that script and will, barring any errors during the compile phase, immediately begin script execution.

The LScript Scripting Plugin is also designed to act as a plugin server, allowing scripts to be added directly to your Custom menu. Once added, selecting an LScript entry will cause the LScript Scripting Plugin to be executed with the selected script. To add an LScript to your Custom menu, you can either use the built-in command Configure List under the Custom menu, or you can simply execute the example LScript listadd.ls included on your distribution diskette.

Please keep in mind that when you add server-based entries to the Custom menu in this fashion, you must save them out to a file. LightWave Modeler will automatically re-load your custom macros each time it is started, provided you have saved them. Refer to the LightWave 3D Modeler manual for more information on this feature.

Conventions Used In This Document

In later sections of this User Guide, identifiers used to describe each command's calling syntax have the following meaning:

number
a numeric data type that includes a
fractional value, optionally
possessing a sign indicator and
exponential specifier.
integer
a numeric data type that is written
as a whole number (i.e., no
fractional value), optionally
possessing a sign indicator
string
a data type that consists of a
sequence of ASCII characters,
enclosed in double quote marks (⌠)
vector
a data type consisting of a group of
three numbers, surrounded by angle
brackets (<>) and separated by commas
(i.e., <15, 34, 5.34>)
point id
a point identifier
polygon id
a polygon identifier
...
a sequence of the data types listed
above, separate by commas, or
multiples of a single data type when
preceded by that data type
void
having no return value; no parameters
accepted
type[#]
an array reference of '#' elements
each of type data type (a missing '#'
indicates a variable size)
[ ]
an optional argument
<data type>
a single instance of any of the above
data types
status
error status of command (unless the
autoerror pragma is used, in which
case errors will be caught and
execution terminated)
boolean
TRUE/true/!0 or FALSE/false/0

Next Section Previous Section Table of Contents Index Errata
© 1996 Virtual Visions, Inc.
© 1997 NewTek, Inc.